Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating docs and build script #3825

Closed
wants to merge 30 commits into from
Closed

Updating docs and build script #3825

wants to merge 30 commits into from

Conversation

BradReesWork
Copy link
Member

Updated Doxygen to produce xml for Sphinx

Updating the build script to:

  • have a build all option
  • build doxygen and then move XML

This will eventually drop the need to publish the C docs

@BradReesWork BradReesWork requested a review from a team as a code owner August 25, 2023 18:33
@BradReesWork BradReesWork marked this pull request as draft August 25, 2023 18:33
@BradReesWork BradReesWork added the DO NOT MERGE Hold off on merging; see PR for details label Aug 25, 2023
@BradReesWork BradReesWork changed the title Updating build script Updating docs and build script Aug 29, 2023
@BradReesWork BradReesWork added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change and removed DO NOT MERGE Hold off on merging; see PR for details labels Sep 12, 2023
@BradReesWork BradReesWork marked this pull request as ready for review September 12, 2023 16:41
@BradReesWork BradReesWork requested review from a team as code owners September 12, 2023 16:41
@BradReesWork BradReesWork requested a review from a team as a code owner September 13, 2023 20:23
acostadon
acostadon requested changes Sep 25, 2023
View reviewed changes
Copy link
Contributor

@acostadon acostadon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found a bad link in basics/cugraph_intro.html
the link to the project board doesn't work.
https://github.com/rapidsai/cugraph/projects/28
that wasn't changed in your pr.

docs/cugraph/source/api_docs/cugraph-pyg/cugraph_pyg.rst
@@ -10,5 +10,5 @@ cugraph-pyg
:toctree: ../api/cugraph-pyg/

cugraph_pyg.data.cugraph_store.EXPERIMENTAL__CuGraphStore
cugraph_pyg.sampler.cugraph_sampler.EXPERIMENTAL__CuGraphSampler
.. cugraph_pyg.sampler.cugraph_sampler.EXPERIMENTAL__CuGraphSampler
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought alex said this was gone?
I looked in the build and it isn't in experimental.

docs/cugraph/source/api_docs/cugraph_c/traversal.rst
.. doxygenfunction:: cugraph_bfs
:project: libcugraph

Single-Source Shortest-Path (SSSP)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2nd Hyphen should be removed...at least according to what I read
Single-Source Shortest Path

@acostadon
Copy link
Contributor

/installation/getting_cugraph.html#docker
Has the old link to docker https://hub.docker.com/r/rapidsai/rapidsai/
needs to be replaced with https://hub.docker.com/r/rapidsai/base I think

@BradReesWork BradReesWork added this to the 23.10 milestone Sep 25, 2023
@acostadon
Copy link
Contributor

acostadon commented Sep 25, 2023 •
edited
Loading

installation/source_build.html

  1. Set the localtion to cuGraph in an environment variable CUGRAPH_HOME

location

  1. Download the cuGraph repo - if you have a folked version, use that path here instead

forked

  1. Where XXX is the CUDA 11 version
    conda env update --name cugraph_dev --file conda/environments/all_cuda-1[XXX]_arch-x86_64.yml
    cuda 11 or 12 now

installation/source_build.html

  1. needs CUDA 12 added

  2. needs new ./build.sh -help text

@BradReesWork BradReesWork modified the milestones: 23.10, 23.12 Sep 25, 2023
@BradReesWork BradReesWork changed the base branch from branch-23.10 to branch-23.12 September 25, 2023 16:51
@BradReesWork
Copy link
Member Author

To be broken into multiple smaller PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@acostadon acostadon acostadon requested changes

Assignees
No one assigned
Labels
improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
None yet
Milestone
23.12
Development

Successfully merging this pull request may close these issues.
3 participants
@BradReesWork @acostadon @rlratzel